home *** CD-ROM | disk | FTP | other *** search
/ Aminet 48 / Aminet 48 (2002)(GTI - Schatztruhe)[!][Apr 2002].iso / Aminet / dev / mui / urltext.lha / Urltext / Developer / Autodocs / MCC_Urltext.doc
Encoding:
Text File  |  2002-01-25  |  5.6 KB  |  194 lines
  1. TABLE OF CONTENTS
  2.  
  3. Urltext.mcc/Urltext.mcc
  4. Urltext.mcc/MUIA_Urltext_Active
  5. Urltext.mcc/MUIA_Urltext_DoOpenURL
  6. Urltext.mcc/MUIA_Urltext_DoVisitedPen
  7. Urltext.mcc/MUIA_Urltext_FallBack
  8. Urltext.mcc/MUIA_Urltext_NoMenu
  9. Urltext.mcc/MUIA_Urltext_SetMax
  10. Urltext.mcc/MUIA_Urltext_Text
  11. Urltext.mcc/MUIA_Urltext_Underline
  12. Urltext.mcc/MUIA_Urltext_Url
  13. Urltext.mcc/MUIA_Urltext_Visited
  14. Urltext.mcc/MUIM_Urltext_Copy
  15. Urltext.mcc/MUIM_Urltext_OpenURL
  16. Urltext.mcc/Urltext.mcc
  17.  
  18. Urltext.mcc is a subclass of Area.mui and offers a very simple text
  19. that acts like an active url, as a html link in a browser. Urltext
  20. is expecially useful in About windows. When the user clicks an Urltext
  21. object, openurl.library is used to reach the url. Urltext.mcc may be
  22. configured in MUI configuration window to adjust colors and other
  23. defaults.
  24.  
  25. Urltext.mcc uses OpenURL system wich is copyright by Troels Walsted Hansen.
  26.  
  27. Urltext.mcc is copyright Alfonso Ranieri <alforan@tin.it>.
  28.  
  29. Urltext.mcc is FREEWARE.
  30.  
  31. E language support is by Jean Holzammer
  32.  
  33. Español support is by Javier de las Rivas
  34. Magyar support is by by Márton Dósa
  35.  
  36. WARNING
  37. This software and information are provided AS IS.
  38. All use is at your own risk, and no liability or
  39. responsibility is assumed. No warranties are made.
  40.  
  41. Note that in the following the attribute scheme is [ISGN].
  42.  
  43. Urltext.mcc/MUIA_Urltext_Active
  44.  
  45.    NAME
  46.     MUIA_Urltext_Active -- [..G.], BOOL
  47.  
  48.    FUNCTION
  49.     Urltext.mcc needs openurl.library installed and configured
  50.     to work. This attribute is set to 1 if OpenURL in installed
  51.     in the system, to 0 otherwise.
  52.  
  53. Urltext.mcc/MUIA_Urltext_DoOpenURL
  54.  
  55.    NAME
  56.     MUIA_Urltext_DoOpenURL -- [I...], BOOL
  57.  
  58.    FUNCTION
  59.     If this attribute is set to 1 (default), the url is reached when
  60.     the user clicks the object. If it is set to 0, nothing happens
  61.     if the user clicks the object.
  62.  
  63. Urltext.mcc/MUIA_Urltext_DoVisitedPen
  64.  
  65.    NAME
  66.     MUIA_Urltext_DoVisitedPen -- [I...], BOOL
  67.  
  68.    FUNCTION
  69.     At creation time this attribute may be set to determinate how
  70.     the text is drawn after the user clicked the object.
  71.     In Urltext preferences, the user may define a color to be used
  72.     to draw the text after the object was clicked.
  73.     If this attribute is set to 1 (default), that color is used.
  74.  
  75.     Note that this attribute overwrites the user preferences and
  76.     therefore it should be used sparerly.
  77.  
  78. Urltext.mcc/MUIA_Urltext_FallBack
  79.  
  80.    NAME
  81.     MUIA_Urltext_Fallback -- [I...], BOOL
  82.  
  83.    FUNCTION
  84.     At creation time this attribute may be set to determinate how
  85.     the text is drawn if OpenURL is not installed in the system.
  86.     If OpenURL is installed in the system, this attribute is not
  87.     used. If OpenURL is not installed in the system and
  88.     MUIA_Urltext_Fallback is 0, the text is drawn with MUI Text
  89.     pen and the object is not active. If OpenURL is not installed
  90.     in the system and MUIA_Urltext_Fallback is 1, the text is drawn
  91.     as OpenURL was installed and the object is active (but nothing
  92.     happens if the user clicks on it).
  93.  
  94.     Note that this attribute overwrites the user preferences and
  95.     therefore it should be used sparerly.
  96.  
  97. Urltext.mcc/MUIA_Urltext_NoMenu
  98.  
  99.    NAME
  100.     MUIA_Urltext_NoMenu -- [I...], BOOL
  101.  
  102.    FUNCTION
  103.     Since Urltext.mcc 14.4, an Urltext object is created with
  104.     a context menu. If you don't want the menu to be created
  105.     set this attribute to 1 or supply your own context menu
  106.     (a NULL is ok).
  107.  
  108. Urltext.mcc/MUIA_Urltext_SetMax
  109.  
  110.    NAME
  111.     MUIA_Urltext_SetMax -- [I...], BOOL
  112.  
  113.    FUNCTION
  114.     Normally, an Urltext object is horiz limited by the width
  115.     of its MUIA_Urltext_Text (or MUIA_Urltext_Url). If this
  116.     attribute is set to 0, the object will be x-unlimited.
  117.  
  118. Urltext.mcc/MUIA_Urltext_Text
  119.  
  120.    NAME
  121.     MUIA_Urltext_Text -- [I.G.], STRPTR
  122.  
  123.    FUNCTION
  124.     This is the text to show. If it is not supplied or it is
  125.     NULL MUIA_Urltext_Url is used. It may be max 256 chars long
  126.     (terminal '\0' included) and it is copied. Note that no MUI
  127.     text engine escape code is recognized.
  128.  
  129. Urltext.mcc/MUIA_Urltext_Underline
  130.  
  131.    NAME
  132.     MUIA_Urltext_Underline -- [I...], BOOL
  133.  
  134.    FUNCTION
  135.     At creation time, this attribute may be used to make the
  136.     text being underlined.
  137.  
  138.     Note that this attribute overwrites the user preferences and
  139.     therefore it should be used sparerly.
  140.  
  141. Urltext.mcc/MUIA_Urltext_Url
  142.  
  143.    NAME
  144.     MUIA_Urltext_Url -- [I.GN], STRPTR
  145.  
  146.  
  147.    FUNCTION
  148.     The url to show. It may be max 256 chars long (terminal '\0'
  149.     included) and it is copied. When the mouse is over the object,
  150.     this attribute is notified. When the mouse is not over the
  151.     object this attribute is notified as NULL. Note that the
  152.     content of this attribute is used instead of MUIA_Urltext_Text,
  153.     if that is not suppleid or it is NULL and that an Urltext
  154.     object is not created if this attribute is not supplied.
  155.  
  156. Urltext.mcc/MUIA_Urltext_Visited
  157.  
  158.    NAME
  159.     MUIA_Urltext_DoVisitedPen -- [..GN], BOOL
  160.  
  161.    FUNCTION
  162.     When the object is clicked for the first time, this attribute
  163.     is set to 1 and notified.
  164.  
  165. Urltext.mcc/MUIM_Urltext_Copy
  166.  
  167.     NAME
  168.     MUIM_Urltext_Copy
  169.  
  170.     SYNOPSIS
  171.     res = DoMethod(obj,MUIM_Urltext_Copy,unit);
  172.  
  173.     FUNCTION
  174.     Invoking this method, the url is copied to the clipboard
  175.     unit number unit.
  176.  
  177.     RESULT
  178.     A boolean to indicates if the url was copied or not.
  179. Urltext.mcc/MUIM_Urltext_OpenURL
  180.  
  181.     NAME
  182.     MUIM_Urltext_OpenURL
  183.  
  184.     SYNOPSIS
  185.     res = DoMethod(obj,MUIM_Urltext_OpenURL,flags);
  186.  
  187.     FUNCTION
  188.     This method make the object to open its url like it was
  189.     clicked by the user. At the moment no flag is used so
  190.     leave it 0.
  191.  
  192.     RESULT
  193.     A boolean to indicates if the url was reached or not.
  194.